Skip to content

Cocoa User Feedback #11191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 19 commits into from
Mar 4, 2025
Merged

Cocoa User Feedback #11191

merged 19 commits into from
Mar 4, 2025

Conversation

armcknight
Copy link
Member

@armcknight armcknight commented Aug 29, 2024 •
edited
Loading

DESCRIBE YOUR PR

Documents a new feature for gathering User Feedback in a Cocoa app, based on the similar feature we already ship in e.g. sentry-javascript. Used https://docs.sentry.io/platforms/javascript/user-feedback/ as inspiration.

sentry-cocoa PR that declares the API: getsentry/sentry-cocoa#4284; tracking work at getsentry/sentry-cocoa#4269

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Make sure we have the correct SDK version in the Installation sectioun
  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel Vercel
Copy link

vercel bot commented Aug 29, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 26, 2025 0:27am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Feb 26, 2025 0:27am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Feb 26, 2025 0:27am

@codecov Codecov
Copy link

codecov bot commented Aug 29, 2024 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 225 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.94MB 231 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.39MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.71MB -0.0%
../instrumentation.js -3 bytes 1.04MB -0.0%
9523.js -3 bytes 1.02MB -0.0%
../app/[[...path]]/page.js.nft.json 80 bytes 379.07kB 0.02%
../app/platform-redirect/page.js.nft.json 80 bytes 378.98kB 0.02%
../app/sitemap.xml/route.js.nft.json 80 bytes 376.95kB 0.02%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 865.35kB -0.0%
static/chunks/1298-*.js -3 bytes 401.61kB -0.0%
static/jPz5REmRuDGPAYe8NTJay/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/jPz5REmRuDGPAYe8NTJay/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/1YkbTd4zmBuamvDAhdUlQ/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/1YkbTd4zmBuamvDAhdUlQ/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

@armcknight armcknight mentioned this pull request Aug 29, 2024
Merged
@armcknight armcknight changed the title wip Cocoa User Feedback Aug 29, 2024
@armcknight armcknight marked this pull request as ready for review September 3, 2024 19:39
@armcknight armcknight marked this pull request as draft September 3, 2024 19:40
bruno-garcia
bruno-garcia reviewed Sep 3, 2024
View reviewed changes
vivianyentran
vivianyentran approved these changes Sep 3, 2024
View reviewed changes
Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding!

@getsantry

This comment was marked as outdated.

Sign in to view
@getsantry getsantry bot added Stale and removed Stale labels Sep 25, 2024
@getsantry

This comment was marked as outdated.

Sign in to view
@getsantry getsantry bot added Stale and removed Stale labels Oct 18, 2024
@coolguyzone

This comment was marked as outdated.

Sign in to view
@getsantry

This comment was marked as outdated.

Sign in to view
@getsantry getsantry bot added Stale and removed Stale labels Nov 22, 2024
@getsantry

This comment was marked as outdated.

Sign in to view
@getsantry getsantry bot added Stale and removed Stale labels Dec 15, 2024
@getsantry

This comment was marked as outdated.

Sign in to view
@getsantry getsantry bot added Stale and removed Stale labels Jan 7, 2025
@armcknight
Copy link
Member Author

Hi @coolguyzone , sorry I missed your message. Yes, I'm preparing to merge this PR now.

This was referenced Feb 19, 2025
Merged
Closed
Merged
@armcknight
Copy link
Member Author

@bruno-garcia Finally got it working again, here are the relevant pages:

bruno-garcia
bruno-garcia approved these changes Feb 19, 2025
View reviewed changes
Copy link
Member

@bruno-garcia bruno-garcia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Super thorough.
One small fix suggested (static API used is JS -> Swift).

Didn't see any migration doc, do we need one from SentryUserFeedback to SentryFeedback ? Possibly a good follow up PR to get ppl to move to the new API.
https://sentry-docs-git-armcknight-featuser-feedbackcocoa-docs.sentry.dev/platforms/apple/migration/

Not a problem with this PR but something we need to look at, the table rendering:
@coolguyzone something you can help us with?

image

@chargome
Copy link
Member

Pushed a small change to your table so it stops overflowing!

@armcknight
Copy link
Member Author

Thanks @chargome!

FYI to all, I'm waiting to merge this PR until getsentry/sentry-cocoa#4873 is approved, so we have alignment between the docs and implementation.

@armcknight

This comment was marked as outdated.

Sign in to view
This was referenced Feb 27, 2025
Closed
Closed
@armcknight
Copy link
Member Author

That last release was retracted, now waiting on deployment of getsentry/publish#5144

@kahest kahest merged commit 8a919ce into master Mar 4, 2025
10 of 11 checks passed
@kahest kahest deleted the armcknight/feat(user-feedback)/cocoa-docs branch March 4, 2025 09:53
@github-actions github-actions bot locked and limited conversation to collaborators Mar 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bruno-garcia bruno-garcia bruno-garcia approved these changes

@vivianyentran vivianyentran vivianyentran approved these changes

Assignees
No one assigned
Labels
WIP
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@armcknight @coolguyzone @bruno-garcia @chargome @vivianyentran @kahest